// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "content/public/test/test_renderer_host.h"

#include <utility>

#include "base/memory/ptr_util.h"
#include "base/run_loop.h"
#include "base/threading/thread_task_runner_handle.h"
#include "build/build_config.h"
#include "content/browser/compositor/test/no_transport_image_transport_factory.h"
#include "content/browser/frame_host/navigation_entry_impl.h"
#include "content/browser/renderer_host/render_view_host_factory.h"
#include "content/browser/renderer_host/render_widget_host_impl.h"
#include "content/browser/site_instance_impl.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/web_contents.h"
#include "content/public/common/browser_side_navigation_policy.h"
#include "content/public/test/browser_side_navigation_test_utils.h"
#include "content/public/test/mock_render_process_host.h"
#include "content/public/test/test_browser_context.h"
#include "content/test/content_browser_sanity_checker.h"
#include "content/test/test_render_frame_host.h"
#include "content/test/test_render_frame_host_factory.h"
#include "content/test/test_render_view_host.h"
#include "content/test/test_render_view_host_factory.h"
#include "content/test/test_web_contents.h"
#include "ui/base/material_design/material_design_controller.h"
#include "ui/base/test/material_design_controller_test_api.h"

#if defined(OS_ANDROID)
#include "content/browser/renderer_host/context_provider_factory_impl_android.h"
#include "content/test/mock_gpu_channel_establish_factory.h"
#include "ui/android/dummy_screen_android.h"
#include "ui/display/screen.h"
#endif

#if defined(OS_WIN)
#include "ui/base/win/scoped_ole_initializer.h"
#endif

#if defined(USE_AURA)
#include "ui/aura/test/aura_test_helper.h"
#include "ui/compositor/test/context_factories_for_test.h"
#include "ui/wm/core/default_activation_client.h"
#endif

#if defined(OS_MACOSX)
#include "ui/accelerated_widget_mac/window_resize_helper_mac.h"
#endif

namespace content {

// RenderFrameHostTester ------------------------------------------------------

// static
RenderFrameHostTester* RenderFrameHostTester::For(RenderFrameHost* host)
{
    return static_cast<TestRenderFrameHost*>(host);
}

// static
void RenderFrameHostTester::CommitPendingLoad(
    NavigationController* controller)
{
    // This function is currently used by BrowserWithTestWindowTest. It would be
    // ideal to instead make the users of that class create TestWebContents
    // (rather than WebContentsImpl directly). This would allow the implementation
    // of PrepareForCommitIfNecessary() to live directly in
    // TestWebContents::CommitPendingNavigation() which could then be the only
    // place to handle this simulation. Unfortunately, it is not trivial to make
    // that change, so for now we have this extra simulation for
    // non-TestWebContents.
    RenderFrameHost* old_rfh = controller->GetWebContents()->GetMainFrame();
    TestRenderFrameHost* old_rfh_tester = static_cast<TestRenderFrameHost*>(old_rfh);
    old_rfh_tester->PrepareForCommitIfNecessary();

    WebContentsImpl* web_contents = static_cast<WebContentsImpl*>(controller->GetWebContents());
    RenderFrameHost* pending_rfh = IsBrowserSideNavigationEnabled()
        ? web_contents->GetRenderManagerForTesting()
              ->speculative_render_frame_host_.get()
        : web_contents->GetRenderManagerForTesting()->pending_frame_host();

    // Commit on the pending_rfh, if one exists.
    RenderFrameHost* test_rfh = pending_rfh ? pending_rfh : old_rfh;
    RenderFrameHostTester* test_rfh_tester = For(test_rfh);

    if (controller->GetPendingEntryIndex() >= 0) {
        test_rfh_tester->SendNavigateWithTransition(
            controller->GetPendingEntry()->GetUniqueID(),
            false,
            controller->GetPendingEntry()->GetURL(),
            controller->GetPendingEntry()->GetTransitionType());
    } else {
        test_rfh_tester->SendNavigateWithTransition(
            controller->GetPendingEntry()->GetUniqueID(),
            true,
            controller->GetPendingEntry()->GetURL(),
            controller->GetPendingEntry()->GetTransitionType());
    }
}

// RenderViewHostTester -------------------------------------------------------

// static
RenderViewHostTester* RenderViewHostTester::For(RenderViewHost* host)
{
    return static_cast<TestRenderViewHost*>(host);
}

// static
bool RenderViewHostTester::TestOnMessageReceived(RenderViewHost* rvh,
    const IPC::Message& msg)
{
    return static_cast<RenderViewHostImpl*>(rvh)->GetWidget()->OnMessageReceived(
        msg);
}

// static
bool RenderViewHostTester::HasTouchEventHandler(RenderViewHost* rvh)
{
    RenderWidgetHostImpl* host_impl = RenderWidgetHostImpl::From(rvh->GetWidget());
    return host_impl->has_touch_handler();
}

// RenderViewHostTestEnabler --------------------------------------------------

RenderViewHostTestEnabler::RenderViewHostTestEnabler()
    : rph_factory_(new MockRenderProcessHostFactory())
    , rvh_factory_(new TestRenderViewHostFactory(rph_factory_.get()))
    , rfh_factory_(new TestRenderFrameHostFactory())
{
#if !defined(OS_ANDROID)
    ImageTransportFactory::InitializeForUnitTests(
        base::WrapUnique(new NoTransportImageTransportFactory));
#else
    gpu_channel_factory_ = base::MakeUnique<MockGpuChannelEstablishFactory>();
    ContextProviderFactoryImpl::Initialize(gpu_channel_factory_.get());
    ui::ContextProviderFactory::SetInstance(
        ContextProviderFactoryImpl::GetInstance());
    if (!screen_)
        screen_.reset(ui::CreateDummyScreenAndroid());
    display::Screen::SetScreenInstance(screen_.get());
#endif
#if defined(OS_MACOSX)
    if (base::ThreadTaskRunnerHandle::IsSet())
        ui::WindowResizeHelperMac::Get()->Init(base::ThreadTaskRunnerHandle::Get());
#endif // OS_MACOSX
}

RenderViewHostTestEnabler::~RenderViewHostTestEnabler()
{
#if defined(OS_MACOSX)
    ui::WindowResizeHelperMac::Get()->ShutdownForTests();
#endif // OS_MACOSX
#if !defined(OS_ANDROID)
    // RenderWidgetHostView holds on to a reference to SurfaceManager, so it
    // must be shut down before the ImageTransportFactory.
    ImageTransportFactory::Terminate();
#else
    display::Screen::SetScreenInstance(nullptr);
    ui::ContextProviderFactory::SetInstance(nullptr);
    ContextProviderFactoryImpl::Terminate();
    gpu_channel_factory_.reset();
#endif
}

// RenderViewHostTestHarness --------------------------------------------------

RenderViewHostTestHarness::RenderViewHostTestHarness()
    : thread_bundle_options_(TestBrowserThreadBundle::DEFAULT)
{
}

RenderViewHostTestHarness::~RenderViewHostTestHarness()
{
}

NavigationController& RenderViewHostTestHarness::controller()
{
    return web_contents()->GetController();
}

WebContents* RenderViewHostTestHarness::web_contents()
{
    return contents_.get();
}

RenderViewHost* RenderViewHostTestHarness::rvh()
{
    RenderViewHost* result = web_contents()->GetRenderViewHost();
    CHECK_EQ(result, web_contents()->GetMainFrame()->GetRenderViewHost());
    return result;
}

RenderViewHost* RenderViewHostTestHarness::pending_rvh()
{
    return pending_main_rfh() ? pending_main_rfh()->GetRenderViewHost() : NULL;
}

RenderViewHost* RenderViewHostTestHarness::active_rvh()
{
    return pending_rvh() ? pending_rvh() : rvh();
}

RenderFrameHost* RenderViewHostTestHarness::main_rfh()
{
    return web_contents()->GetMainFrame();
}

RenderFrameHost* RenderViewHostTestHarness::pending_main_rfh()
{
    return WebContentsTester::For(web_contents())->GetPendingMainFrame();
}

BrowserContext* RenderViewHostTestHarness::browser_context()
{
    return browser_context_.get();
}

MockRenderProcessHost* RenderViewHostTestHarness::process()
{
    return static_cast<MockRenderProcessHost*>(active_rvh()->GetProcess());
}

void RenderViewHostTestHarness::DeleteContents()
{
    SetContents(NULL);
}

void RenderViewHostTestHarness::SetContents(WebContents* contents)
{
    contents_.reset(contents);
}

WebContents* RenderViewHostTestHarness::CreateTestWebContents()
{
    // Make sure we ran SetUp() already.
#if defined(OS_WIN)
    DCHECK(ole_initializer_ != NULL);
#endif
#if defined(USE_AURA)
    DCHECK(aura_test_helper_ != NULL);
#endif

    scoped_refptr<SiteInstance> instance = SiteInstance::Create(browser_context_.get());
    instance->GetProcess()->Init();

    return TestWebContents::Create(browser_context_.get(), std::move(instance));
}

void RenderViewHostTestHarness::NavigateAndCommit(const GURL& url)
{
    static_cast<TestWebContents*>(web_contents())->NavigateAndCommit(url);
}

void RenderViewHostTestHarness::Reload()
{
    NavigationEntry* entry = controller().GetLastCommittedEntry();
    DCHECK(entry);
    controller().Reload(ReloadType::NORMAL, false);
    RenderFrameHostTester::For(main_rfh())
        ->SendNavigateWithTransition(entry->GetUniqueID(),
            false, entry->GetURL(),
            ui::PAGE_TRANSITION_RELOAD);
}

void RenderViewHostTestHarness::FailedReload()
{
    NavigationEntry* entry = controller().GetLastCommittedEntry();
    DCHECK(entry);
    controller().Reload(ReloadType::NORMAL, false);
    RenderFrameHostTester::For(main_rfh())
        ->SendFailedNavigate(entry->GetUniqueID(), false, entry->GetURL());
}

void RenderViewHostTestHarness::SetUp()
{
    // ContentTestSuiteBase might have already initialized
    // MaterialDesignController in unit_tests suite.
    ui::test::MaterialDesignControllerTestAPI::Uninitialize();
    ui::MaterialDesignController::Initialize();
    thread_bundle_.reset(new TestBrowserThreadBundle(thread_bundle_options_));

    rvh_test_enabler_.reset(new RenderViewHostTestEnabler);
    if (factory_)
        rvh_test_enabler_->rvh_factory_->set_render_process_host_factory(factory_);

#if defined(OS_WIN)
    ole_initializer_.reset(new ui::ScopedOleInitializer());
#endif
#if defined(USE_AURA)
    ui::ContextFactory* context_factory = ImageTransportFactory::GetInstance()->GetContextFactory();
    ui::ContextFactoryPrivate* context_factory_private = ImageTransportFactory::GetInstance()->GetContextFactoryPrivate();

    aura_test_helper_.reset(
        new aura::test::AuraTestHelper(base::MessageLoopForUI::current()));
    aura_test_helper_->SetUp(context_factory, context_factory_private);
    new wm::DefaultActivationClient(aura_test_helper_->root_window());
#endif

    sanity_checker_.reset(new ContentBrowserSanityChecker());

    DCHECK(!browser_context_);
    browser_context_.reset(CreateBrowserContext());

    SetContents(CreateTestWebContents());

    if (IsBrowserSideNavigationEnabled())
        BrowserSideNavigationSetUp();
}

void RenderViewHostTestHarness::TearDown()
{
    if (IsBrowserSideNavigationEnabled())
        BrowserSideNavigationTearDown();

    SetContents(NULL);
#if defined(USE_AURA)
    aura_test_helper_->TearDown();
    ui::TerminateContextFactoryForTests();
#endif
    // Make sure that we flush any messages related to WebContentsImpl destruction
    // before we destroy the browser context.
    base::RunLoop().RunUntilIdle();

#if defined(OS_WIN)
    ole_initializer_.reset();
#endif

    // Delete any RenderProcessHosts before the BrowserContext goes away.
    if (rvh_test_enabler_->rph_factory_)
        rvh_test_enabler_->rph_factory_.reset();

    rvh_test_enabler_.reset();

    // Release the browser context by posting itself on the end of the task
    // queue. This is preferable to immediate deletion because it will behave
    // properly if the |rph_factory_| reset above enqueued any tasks which
    // depend on |browser_context_|.
    BrowserThread::DeleteSoon(content::BrowserThread::UI,
        FROM_HERE,
        browser_context_.release());
    thread_bundle_.reset();
}

BrowserContext* RenderViewHostTestHarness::CreateBrowserContext()
{
    return new TestBrowserContext();
}

void RenderViewHostTestHarness::SetRenderProcessHostFactory(
    RenderProcessHostFactory* factory)
{
    if (rvh_test_enabler_)
        rvh_test_enabler_->rvh_factory_->set_render_process_host_factory(factory);
    else
        factory_ = factory;
}

} // namespace content
